using System;
using Microsoft.SPOT.Hardware;
using Gadgeteer;
using Gadgeteer.Modules;

/*
 * Original Gadgeteer framework Copyright (c) Microsoft Corporation. (http://gadgeteer.codeplex.com/)
 * 
 * Gadgeteer Light made by Stefan Thoolen (http://gadgeteerlight.codeplex.com/)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace Gadgeteer.Interfaces
{
    /// <summary>Wrapper for an analog input port</summary>
    public class AnalogInput
    {
        /// <summary>The actual analog input port</summary>
        private Gadgeteer.AnalogInProvider _port = null;

        /// <summary>Creates a new analog input port</summary>
        /// <param name="socket">The socket on which the port exists</param>
        /// <param name="pin">The pin #</param>
        /// <param name="module">The module driving this pin</param>
        public AnalogInput(Socket socket, Socket.Pin pin, Module module)
        {
            this._port = Gadgeteer.Board.Hardware.GetAnalogInProvider(socket.SocketNumber, (int)pin);
        }

        /// <summary>Is the port active?</summary>
        public bool Active {
            get { return this._port.Active; } 
            set { this._port.Active = value; } 
        }

        /// <summary>Reads the current voltage</summary>
        /// <returns>Value from 0.0 to 3.3</returns>
        public double ReadVoltage()
        {
            return this.ReadVoltage();
        }

        /// <summary>Reads the analog value</summary>
        /// <returns>Value from 0.0 to 1.0</returns>
        public double ReadProportion()
        {
            return this._port.ReadProportion();
        }
    }
}
